Return to Main ContentsShowTable of Contents
This section provides a Quick Start Guide for setting Expeditor integrator. A simple local file transfer use case is configured which allows
- picking up a given file from the local file system and
- detaching a received file in the JMS payload to the local file system
First Expeditor integrator Runtime Test
As a first test, the manual configuration update use case can be tested. For this, follow these steps:
- Enable logging to console window by editing the following line in <XPDINTEG_HOME>/rcp/eclipse/features/com.ibm.rcp.integrator.feature_<version>.<build>/handler.properties
-Dcom.ibm.rcp.integrator.showflowstatus=true
and reset the runtime with resetscript/XPDintegReset.bat/sh (see
chapter 5.1 Start/Stop Expeditor integrator)
- Start Expeditor integrator by executing <XPDINTEG_HOME>/XPDintegStart.bat. (or XPDintegStart.sh for Linux) Log messages might appear in the Expeditor integrator (OSGi) console stating that the House Keeping process is running (see Figure 4). You can ignore these for now.
Figure 4: Expeditor integrator runtime console (OSGi Console)
- Locate the XPDinteg.xml file under <XPDINTEG_HOME>/config
- Copy the file to the new directory (<XPDINTEG_HOME>/config/new)
- Depending on the configured polling interval for the Configuration Update Resource Adapter, the new configuration file will be discovered and applied (standard value = 60’000 msec = 1 min)
- The new configuration file is automatically processed and applied. The Expeditor integrator console will show a log message which confirms the configuration change (see console output in Figure 5)
Figure 5: Expeditor integrator console output during manual configuration update
If this output is seen, IBM Lotus Expeditor integrator runtime is ready and can be configured for connecting to the business back-end.
Note: The Expeditor integrator Monitoring tool can also be used for retrieving status information about processes of the Expeditor integrator instance. Please, refer to
chapter 7.4 Monitoring Tool Page for more details.
Configuration for Local File System File Transfer Example
This chapter shows how to use provided sample XPDinteg.xml files to get started quickly with the local file transfer business use cases:
- On appearance, transfer given file from given directory to messaging back-end
- Transfer file from messaging back-end to Expeditor integrator and detach it to given local directory
The initially delivered XPDinteg.xml configuration file is located in the <XPDINTEG_HOME>/config directory. It holds very basic configuration which start Expeditor integrator without back-end connectivity. The provided Local File System Resource Adapter and Resource Mapper configuration should be reviewed.
There are additional sample configuration files available in the <XPDINTEG_HOME>/samples/config folder. Please, choose an appropriate one. For the exchanging local file system files example, please retrieve the Sample_for_LocalFSTransfers_XPDinteg.xml and copy it into the <XPDINTEG_HOME>/config folder. Re-name the existing XPDinteg.xml for later reference (e.g. in XPDinteg_initial.xml). The Sample_for_LocalFSTransfers_XPDinteg.xml contains a prepared sample configuration for connectivity to the back-end messaging system and the LocalFileSystem Resource Adapter.
Please, rename the Sample_for_LocalFSTransfers_XPDinteg.xml in XPDinteg.xml and follow the instructions in the next chapters for adjusting this configuration to your environment.
Configuring Back end Systems
For the simple file transfer use case, an IBM WebSphere MQ based back-end messaging system is recommended.
- Set-up the required standard back-end queues as described in chapter 2 Queue Configuration at Application Integration Back-end .
- Edit the XPDinteg.xml file (previously provided as Sample_for_LocalFSTransfers_XPDinteg.xml) and configure the back-end messaging connection (Messaging Service):
- Provide the unique LocationId (place holder = location_id)
- Configure the Messaging Service by replacing the included place holders with your values (more details are given in chapter 4.3.3 Configuration of Back-end Connectivity through Lotus Expeditor micro broker bridge). Replace:
- backbone_service_bus,
- backbone_svc_bus_port,
- MQ_backend_Q_manager,
- MQ_backend_srv_channel
- Replace back-end queue names in remote queue configuration section of XPDinteg.xml with your back-end queue names configured in Step 1 above (e.g. replace ReqOutQx, ResInQx and CtrlOutQx in section 4.1 of XPDinteg.xml with your environment settings).
Note: The monitoring and remote management option is not used in this example. Also, note that the connectivity status information can be retrieved by entering the following commands in the Expeditor integrator console (OSGi console; see
chapter 4.3.3 Configuration of Back-end Connectivity through Lotus Expeditor micro broker bridge):
- checkadapterstatus <adapter_name>
- checkmsgserverstatus <pipe_name>
Information about executed Application Control Flows and connected messaging clients can also be retrieved. Refer to section
7 Expeditor Integrator console commands for more possible Expeditor integrator console commands.
Configuring Local File System Resource Adapters
The following configuration steps are required in Expeditor integrator for the Local File System Transfer example:
- Configure Expeditor integrator to transfer the given XPDinteg_sample.txt file from the <XPDINTEG_HOME>/datatrans/outbound directory to the back-end messaging system:
- Open the XPDinteg.xml file and note the Local File System Resource Adapter configuration for monitoring the <XPDINTEG_HOME>/datatrans/outbound directory for existence of the XPDinteg_sample.txt file (poll every minute). Review the provided configuration under <resource-monitor-service> (see Listing 1).
Note, that the ResourceType=SampleFileSystemFile is assigned to this adapter. This will be used to further configure the file transfer options under the Resource Mapper (see Listing 1).
- Furthermore, locate the Resource Mapper configuration in the @nowiki@13section of the XPDinteg.xml and review the configuration for the ResourceType=SampleFileSystemFile (Listing 2).
Note, that the original XPDinteg_sample.txt file will be copied to XPDinteg_sample-transferred.txt when it was successfully transferred to the back-end system.
Listing 1: File System Adapter configuration example for SampleFileSystemFile
<resource-monitor-service>
<adapters>
<adapter type="XPDINTEG_FILE_SYSTEM_ADAPTER" name="AdapterForLocalFile">
<polling>
<interval>60000</interval>
<meta-data>ASCII-datatrans/outbound/XPDinteg_sample.txt</meta-data>
<topic>com/ibm/integrator/flowtriggerevent/FileTransfer/LocalFileSystem/LocalFileSystemAdapter
</topic>
</polling>
<configuration>
<param name="ResourceType" value="SampleFileSystemFile"/>
</configuration>
</adapter>
Listing 2: Resource Mapper configuration example (outbound: Expeditor integrator -> back-end). When file is picked up, the source file XPDinteg_sample.txt is copied to XPDinteg_sample-transferred.txt in the source directory /datatrans/outbound/)
<resources>
<outbound-mappings>
<resource-mapping type="SampleFileSystemFile">
<param name="TransportType" value="LocalFileSystem"/>
<param name="Description" value="Sample mapper for local files in datatrans outbound dir"/>
<param name="TransferMode" value="ASCII"/>
<param name="TransferConfirmationMode" value="WriteOtherFile"/>
<param name="WriteOtherFileName" value="datatrans/outbound/XPDinteg_sample-transferred.txt"/>
<param name="Encoding" value="UTF-8"/>
<param name="TransferPriority" value="9"/>
</resource-mapping>
- Configure Expeditor integrator to detach the payload of a received message with the following JMS Custom Header values:
MessagePurpose=FileTransfer
TransportType=LocalFileSystem
ResourceType=SampleFileSystemFile
LocationId=your_id, MessageId=your_msg_id, TransactionId=your_trans_id, EoD=true
to the <XPDINTEG_HOME>datatrans/inbound directory as sample.txt file.
- Create a message which contains a sample ASCII file with the required JMS Custom Header values above .
- Locate the Resource Mapper configuration in the <resources><inbound-mappings> section of the XPDinteg.xml and review the configuration for the ResourceType=SampleFileSystemFile (see Listing 3).
Note, that the received message payload will be detached as sample.txt file into the <XPDINTEG_HOME>/datatrans/inbound directory.
Listing 3: Resource Mapper configuration example (inbound: Payload of received FileTransfer message with ResourceType=SampleFileSystemFile is detached as sample.txt file to local datatrans/inbound directory)
<resources>
<inbound-mappings>
<resource-mapping type="SampleFileSystemFile">
<!-- Kicks of Sample_PutSampleLocalFileSystemFile.flow -->
<param name="TransportType" value="LocalFileSystem"/>
<param name="Description" value="Write sample file system file to datatrans inbound directory"/>
<param name="TransferMode" value="ASCII"/>
<param name="DestinationCreationMode" value="APPEND"/>
<param name="DestinationPath" value="datatrans/inbound"/>
<param name="DestinationName" value="sample.txt"/>
<param name="Encoding" value="UTF-8"/>
</resource-mapping>
- Apply the changed configuration to the Expeditor integrator runtime:
- If Expeditor integrator is running, please, stop it (Type close into the console window and press Enter.)
- Re-name <XPDINTEG_HOME>/datatrans/outbound/sample.txt in XPDinteg_sample.txt
- Run <XPDINTEG_HOME>/resetscript/XPDintegReset.bat
- Start Expeditor integrator by running <XPDINTEG_HOME>/XPDintegStart.bat
- Now, wait until the /datatrans/outbound/XPDinteg_sample.txt file is picked up (the XPDinteg_sample-transferred.txt copy will appear).
- Send the FileTransfer message from Step_2 with ResourceType=SampleFileSystemFile to the Expeditor integrator and notice that the message payload is detached as sample.txt file to the datatrans/inbound directory.
Check the OSGi console output which reports the execution of the triggered flows (e.g. for picking up the <XPDINTEG_HOME>/datatrans/outbound/XPDinteg_sample.txt file):
2008-11-25 13:59:18.686 : GetFileSystemFiles_Process/STARTED
2008-11-25 13:59:19.092 : GetFileSystemFiles_Process/FINISHED
Also, notice that the file is re-named in
XPDinteg_sample-transferred.txt (as configured in the Resource Mapper).
Note: The Expeditor integrator Monitoring tool can also be used for retrieving this status information from the Expeditor integrator instance. Please, refer to
chapter 7.4 Monitoring Tool Page for more details.